feat(asyncpg): add capture_connection_cleanup option to silence pool cleanup spans#4373
Open
RiyaChaturvedi37 wants to merge 13 commits intoopen-telemetry:mainfrom
Open
feat(asyncpg): add capture_connection_cleanup option to silence pool cleanup spans#4373RiyaChaturvedi37 wants to merge 13 commits intoopen-telemetry:mainfrom
RiyaChaturvedi37 wants to merge 13 commits intoopen-telemetry:mainfrom
Conversation
…cleanup spans Closes open-telemetry#4264
RiyaChaturvedi37
force-pushed
the
fix/asyncpg-silence-cleanup
branch
from
5547d9b to
73f9258
Compare
instrumentation/opentelemetry-instrumentation-asyncpg/tests/test_asyncpg_wrapper.py
Show resolved
Hide resolved
.../opentelemetry-instrumentation-asyncpg/src/opentelemetry/instrumentation/asyncpg/__init__.py
Show resolved
Hide resolved
tammy-baylis-swi
moved this from Ready for review
to Reviewed PRs that need fixes
in Python PR digest
Contributor
|
Thank you for this @RiyaChaturvedi37 ! I have added some comments |
Contributor
Author
|
Note: The large diff (+2440/-2389) is due to Windows line ending (CRLF) differences in the existing file on my local machine. The actual code changes are minimal — only 3 files with the new feature, tests, and changelog entry. I apologize for the noise! |
.../opentelemetry-instrumentation-asyncpg/src/opentelemetry/instrumentation/asyncpg/__init__.py
Outdated
Show resolved
Hide resolved
tammy-baylis-swi
approved these changes
Mar 31, 2026
Contributor
tammy-baylis-swi
left a comment
tammy-baylis-swi
left a comment
There was a problem hiding this comment.
Thank you for fixes, lgtm! Just suggested a small docs update. The Maintainers will also have to review this.
tammy-baylis-swi
moved this from Reviewed PRs that need fixes
to Ready for review
in Python PR digest
Contributor
Author
Done! Added the clarifying comment as suggested. |
xrmx
reviewed
Apr 3, 2026
.../opentelemetry-instrumentation-asyncpg/src/opentelemetry/instrumentation/asyncpg/__init__.py
Outdated
Show resolved
Hide resolved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #4264
Description
Adds a new
capture_connection_cleanupoption toAsyncPGInstrumentorto allow silencing connection cleanup spans when using a pool.
When using a connection pool, asyncpg executes cleanup statements after
each invocation:
These can pollute traces, especially for tasks that periodically query
the database. This option allows users to silence these spans.
Usage:
The option defaults to
Trueto maintain backward compatibility.Type of change